home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XClearArea.z / XClearArea
Encoding:
Text File  |  2002-10-03  |  5.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXCCCClllleeeeaaaarrrrAAAArrrreeeeaaaa((((3333XXXX11111111))))   XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))    XXXXCCCClllleeeeaaaarrrrAAAArrrreeeeaaaa((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XClearArea, XClearWindow - clear area or window
  10.  
  11.      SSSSYYYYNNNNTTTTAAAAXXXX
  12.           XClearArea(_d_i_s_p_l_a_y, _w, _x, _y, _w_i_d_t_h, _h_e_i_g_h_t, _e_x_p_o_s_u_r_e_s)
  13.                 Display *_d_i_s_p_l_a_y;
  14.                 Window _w;
  15.                 int _x, _y;
  16.                 unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
  17.                 Bool _e_x_p_o_s_u_r_e_s;
  18.  
  19.           XClearWindow(_d_i_s_p_l_a_y, _w)
  20.                 Display *_d_i_s_p_l_a_y;
  21.                 Window _w;
  22.  
  23.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  24.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  25.  
  26.           _e_x_p_o_s_u_r_e_s Specifies a Boolean value that indicates if _E_x_p_o_s_e
  27.                     events are to be generated.
  28.  
  29.           _w         Specifies the window.
  30.  
  31.           _w_i_d_t_h
  32.           _h_e_i_g_h_t    Specify the width and height, which are the
  33.                     dimensions of the rectangle.
  34.  
  35.           _x
  36.           _y         Specify the x and y coordinates, which are
  37.                     relative to the origin of the window and specify
  38.                     the upper-left corner of the rectangle.
  39.  
  40.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  41.           The _X_C_l_e_a_r_A_r_e_a function paints a rectangular area in the
  42.           specified window according to the specified dimensions with
  43.           the window's background pixel or pixmap.  The subwindow-mode
  44.           effectively is _C_l_i_p_B_y_C_h_i_l_d_r_e_n.  If width is zero, it is
  45.           replaced with the current width of the window minus x.  If
  46.           height is zero, it is replaced with the current height of
  47.           the window minus y.  If the window has a defined background
  48.           tile, the rectangle clipped by any children is filled with
  49.           this tile.  If the window has background _N_o_n_e, the contents
  50.           of the window are not changed. In either case, if exposures
  51.           is _T_r_u_e, one or more _E_x_p_o_s_e events are generated for regions
  52.           of the rectangle that are either visible or are being
  53.           retained in a backing store.  If you specify a window whose
  54.           class is _I_n_p_u_t_O_n_l_y, a _B_a_d_M_a_t_c_h error results.
  55.  
  56.           _X_C_l_e_a_r_A_r_e_a can generate _B_a_d_M_a_t_c_h, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w
  57.           errors.
  58.  
  59.           The _X_C_l_e_a_r_W_i_n_d_o_w function clears the entire area in the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXCCCClllleeeeaaaarrrrAAAArrrreeeeaaaa((((3333XXXX11111111))))   XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))    XXXXCCCClllleeeeaaaarrrrAAAArrrreeeeaaaa((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           specified window and is equivalent to _X_C_l_e_a_r_A_r_e_a (display,
  75.           w, 0, 0, 0, 0, _F_a_l_s_e).  If the window has a defined
  76.           background tile, the rectangle is tiled with a plane-mask of
  77.           all ones and _G_X_c_o_p_y function.  If the window has background
  78.           _N_o_n_e, the contents of the window are not changed. If you
  79.           specify a window whose class is _I_n_p_u_t_O_n_l_y, a _B_a_d_M_a_t_c_h error
  80.           results.
  81.  
  82.           _X_C_l_e_a_r_W_i_n_d_o_w can generate _B_a_d_M_a_t_c_h and _B_a_d_W_i_n_d_o_w errors.
  83.  
  84.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  85.           _B_a_d_M_a_t_c_h  An _I_n_p_u_t_O_n_l_y window is used as a Drawable.
  86.  
  87.           _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of
  88.                     values accepted by the request.  Unless a specific
  89.                     range is specified for an argument, the full range
  90.                     defined by the argument's type is accepted.  Any
  91.                     argument defined as a set of alternatives can
  92.                     generate this error.
  93.  
  94.           _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  95.                     defined Window.
  96.  
  97.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  98.           XCopyArea(3X11)
  99.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.